home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1994 November: Tool Chest / Dev.CD Nov 94.toast / Tool Chest / Testing & Debugging / Virtual User tools / VU Aid 1.0.8 / •VU Aid 1.0.8 Module Info next >
Encoding:
Text File  |  1993-09-17  |  6.7 KB  |  178 lines  |  [TEXT/MPS ]
  1.                     VU Aid 1.0.8 Module Information and Examples
  2.  
  3. STANDARD MODULES:
  4.  
  5. db                - Display byte of memory.  The only parameter is the memory
  6.                   location in DECIMAL.
  7.                   example: db 15   Returns: -1
  8.                   
  9. dw                - Display word of memory.  The only parameter is the memory
  10.                   location in DECIMAL.
  11.                   example: dw 44   Returns: 1
  12.  
  13. dl                - Display long word of memory.  The only parameter is the memory
  14.                   location in decimal.
  15.                   example: dl 44   Returns: 130218
  16.                   
  17. sb                - Set byte of memory.  Two parameters: memory location
  18.                   in decimal and value in decimal.
  19.                   example: sb 15 44   Returns: 0
  20.                   
  21. sw                - Set word of memory.  Two parameters: memory location
  22.                   in decimal and value in decimal.
  23.                   example: sw 8 16   Returns: --
  24.                   
  25. sl                - Set long word of memory.  Two parameters: memory location
  26.                   in decimal and value in decimal.
  27.                   example: sl 8 16   Returns: --
  28.                   
  29. DebugStr        - Sends a string to MacsBug.  The only parameter is the string
  30.                   to be sent to MacsBug.  (WARNING: if the string does not end
  31.                   with some sort of return, e.g. "g", the machine will not return).
  32.                   example: debugstr 'g'   Returns: --
  33.                   
  34. Clipboard        - Returns the text currently on the clipboard.  No parameters.
  35.                   example: clipboard    Returns: "<string>"
  36.  
  37.  
  38. ADDITIONS:
  39.  
  40.  
  41. Balloon            - Returns a checksum of the screen image of the current help
  42.                   balloon. The balloon can be on any screen. The checksum is ALWAYS
  43.                   THE SAME for the same balloon, regardless of screen depth,
  44.                   position on the screen, or shape of the balloon--only the text
  45.                   part of the balloon is checksummed. If there is no balloon, an
  46.                   error is returned. No parameters.
  47.                   example: balloon    Returns: 44822
  48.  
  49. Brightness        - Returns the current brightness on the machines that support it.
  50.                   If a parameter is given, it will set the brightness to that
  51.                   value. The possible range of value is determined by the driver.
  52.                   Note that if you set the brightness to 0, you will not see anything.
  53.                   example:     Returns: 
  54.  
  55. ClipCompare        - Checksums the contents of the clipboard.  Only parameter is the
  56.                   type of scrap to retrieve - TEXT, PICT, snd, etc.
  57.                   
  58. CountFonts        - Counts the number of fonts installed in the system. No
  59.                   parameters.
  60.                   example: countfonts    Returns: 19
  61.                   
  62. Delete            - Deletes a file.  The only parameter is the file name.
  63.                   The full pathname of the file is required.
  64.                   example: delete “<internal drive>:<file name>“    Returns: --
  65.                   
  66. Date            - Return the Date in formatted form.  No parameters.
  67.                   example: date    Returns: 3/4/1992
  68.                   
  69. FreeMem            - Returns the amount of free memory in the system, not to
  70.                   be confused with the largest unused block.  No parameters.
  71.                   example: freemem    Returns: 6194540
  72.                   
  73. Gestalt            - Allows any gestalt call.  The only parameter is the gestalt
  74.                   selector.  For example, to see if VM is running, one
  75.                   would type "gestalt vm".
  76.                   example: varies    Returns: varies
  77.                   
  78. GetDepth        - Returns the bit depth of the main gdevice.  No parameters.
  79.                   example: getdepth    Returns: 8
  80.  
  81. GetGray            - Returns 1 if the main gdevice is set to gray-scale, 0 if color.
  82.  
  83. InvertScreen    - Inverts the screen or portion thereof, using the same parameters
  84.                   as ScreenCompare, thus allowing a visual check of the checksum area.
  85.  
  86. InvertWindow    - Inverts the 2nd window or portion thereof, using the same parameters
  87.                   as Window2Compare, thus allowing a visual check of the checksum area.
  88.                   
  89. Launch            - Launches a file.  First parameter is the file to launch, followed
  90.                   by a list of documents to open.
  91.                   example: Launch “TeachText” “Read Me”    Returns: --
  92.                   
  93. MaxMem            - Returns the largest unused block of memory available. No
  94.                   parameters.
  95.                   example: maxmem    Returns: 6215652
  96.  
  97. Move            - Moves a file.  First parameter is the source, second is the
  98.                   destination.  Full pathnames are required.
  99.                   example: Move “<source drive>: <source file>“ “<target drive>::<target file>“
  100.                   Returns: --
  101.  
  102. Rename            - Renames a file.  First parameter is the old name, second is the
  103.                   new name.  Full pathnames are required.
  104.                   example: Rename “<source drive>: <source file>“ “<source drive>: <new name of file>“
  105.                   returns: --
  106.                   
  107. RM                - Turns off VM.
  108.                   example: RM 8    Returns: --
  109.  
  110. ScreenCompare    - Returns the checksum of the startup screen.  Optional
  111.                   parameters: rect of area to checksum.
  112.                   Note: Must be called in inviso-mode or the VUAid dialog will be checksummed.
  113.                   Note: Returns a different checksum for each bit-depth.
  114.                   Note: Hides cursor before checksumming.
  115.                   example: screencompare    Returns: checksum number of screen
  116.  
  117. SetDepth        - Sets the bit depth of the main gdevice.  The only parameters is
  118.                   the new bit-depth: 1,2,4,8,32.
  119.                   example: setdepth 2    Returns: --
  120.  
  121. Time            - Returns the time already formatted.  No parameters.
  122.                   example: Time    Returns: 11:43:21
  123.                   
  124. VM                - Turns on VM.
  125.                   example: VM 12 <drive>   Returns: --
  126.                   
  127. WindowCompare    - Returns the checksum of the frontmost window.  Optional
  128.                   parameters: rect of area relative to window to checksum.
  129.                   Note: Must be called in inviso-mode or the VUAid dialog will be checksummed.
  130.                   Note: Returns a different checksum for each bit-depth.
  131.                   Note: Hides cursor before checksumming.
  132.                   example: WindowCompare     Returns: checksum number of window
  133.  
  134. Window2Compare    - Same as WindowCompare but operates on second-most window,
  135.                   eliminating the need for invisible mode.
  136.                   
  137. 24                - Turns off 32-bit mode.  No parameters.
  138.                   example: 24   Returns: --
  139.                   
  140. 32                - Turns on 32-bit mode.  No parameters.
  141.                   example: 32   Returns: --
  142.  
  143. OTHERS:
  144.  
  145. dgb                - Display a global byte. One parameter which is offset of global
  146.                   from A5. For example, for a global located at -$10(A5), use
  147.                   "dgb 16" to read it.
  148.                   example: dgb 16   Returns: 0
  149.                   
  150. dgw                - Display a global word (16-bits). Same parameters as "dgb".
  151.                   example: dgw 16   Returns: 0
  152.                   
  153. dgl                - Display a global long (32-bits). Same parameters as "dgb".
  154.                   example: dgl 16   Returns: 0
  155.                   
  156. dgstr            - Display a global Pascal string. Same parameters as "dgb".
  157.                   example: dgstr 16  Returns: 0
  158.                   
  159. echo            - Echo all parameters. Parameters are echoed in double quotes,
  160.                   delimited by commas. Example: "echo a b c" results in "a","b","c".
  161.                   example: echo a b c   Returns: "a", "b", "c"
  162.                   
  163. ERROR HANDLING AND LIMITATIONS
  164.  
  165.     VUAid returns System errors.  
  166.     The following is a list of common errors which VU Aid returns.
  167.  
  168.     Sys Error    Definition
  169.     -28        Drvr not opened (i.e. Brightness Control Panel not supported)
  170.     -35        No such volume
  171.     -43        File not found.
  172.  
  173.  
  174. EOF
  175.     
  176.     
  177.             Copyright Apple Computer, Inc. 1992. All rights reserved. 
  178.                 This is an unsupported Apple product.